transcribe | SignalWire

Start transcribing an active call in the background. The transcription covers the whole call and completes when the call ends. For real-time transcription, use live transcription. Status updates are delivered to the optional status_url.

control_id is a caller-chosen identifier for this operation, unique per active operation of this kind on the call. The TypeScript SDK types it as optional, but the API requires it — a request that omits it is rejected.

Keep it to stop the transcription later with transcribeStop.

Request

idstringRequiredformat: "uuid"

The unique identifying ID of an existing call.

paramsobjectRequired

An object of parameters that will be utilized by the active command.

Response

Call LegobjectRequired

Returned when the call is a standard PSTN, SIP, or WebRTC call.

Fabric Subscriber Device LegobjectRequired

Returned when the call is a Fabric subscriber device leg. The status field is always null for this type.

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
await client.calling.transcribe("call-id-xxx", {
  control_id: "transcribe-1",
  status_url: "https://example.com/transcribe-status",
});